﻿// -----------------------------------------------------------------------
// <copyright file="ILocalizedStringsSource.cs" company="Moveax, LLC">
// Copyright (c) 2013 Andrey Veselov. All rights reserved.
// License:  Microsoft Public License (MS-PL)
// Contacts: http://andrey.moveax.com andrey@moveax.com
// </copyright>
// -----------------------------------------------------------------------

namespace Moveax.Pluralization.Core
{
    using System.Globalization;

    /// <summary>Defines the functionality of an strings source object.</summary>
    public interface ILocalizedStringsSource
    {
        /// <summary>Returns the string value that selected by the plural category and the specified culture.</summary>
        /// <param name="name">The name of the string to retrieve.</param>
        /// <param name="pluralCategory">The plural category.</param>
        /// <param name="cultureInfo">An object that represents the culture for which the resource is localized.</param>
        /// <returns>The string value for the specified name, or null if nothing appropriate cannot be found.</returns>
        string GetString(string name, PluralCategory pluralCategory, CultureInfo cultureInfo);
    }
}
